Skip to content

fix(rxjs): Include index functions and improve scraper coverage (#2529) #2540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

aditya-7562
Copy link

Fixes #2529

This PR enhances the RxJS documentation by introducing a dedicated Top-level Functions category in the DevDocs sidebar. This improves discoverability for core RxJS functions such as of(), from(), and merge(), which were previously uncategorized or grouped under "Miscellaneous".

✅ Changes Made:

  • Updated lib::docs::filters::rxjs::entriesget_type to return Top-level Functions for root-level api/ entries that don't belong to any operator class (e.g., ajax, animationFrameScheduler, etc.).

  • Sidebar now reflects the new grouping for standalone functional APIs.

  • Ensured no impact to existing guide sections or categorized operators.

🧪 Testing

  • Ran the scraper locally and verified a successful build

  • Confirmed sidebar now contains a Top-level Functions section

  • Verified visual consistency and link correctness across updated entries

@aditya-7562 aditya-7562 requested a review from a team as a code owner July 17, 2025 09:04
@simon04
Copy link
Contributor

simon04 commented Jul 21, 2025

timeInterval appears twice now as http://localhost:9292/rxjs/api/operators/timeinterval and http://localhost:9292/rxjs/api/index/function/timeinterval. Is this intended?

@aditya-7562
Copy link
Author

timeInterval appears twice now as http://localhost:9292/rxjs/api/operators/timeinterval and http://localhost:9292/rxjs/api/index/function/timeinterval. Is this intended?

Thanks for catching that!

Yeah, the duplication is actually intentional — it matches how the official RxJS docs list timeInterval in both the standalone functions and the operators section. Since it’s validly part of both, the scraper now reflects that to stay consistent with the source.

That said, if you think we should clean it up or consolidate one of the paths in DevDocs, I’m happy to make the change!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RxJS does not include top level "index" functions
2 participants